home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / MAPPINGSTORAGE.PY < prev    next >
Encoding:
Python Source  |  1999-07-11  |  8.8 KB  |  268 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85. """Very Simple Mapping ZODB storage
  86.  
  87. The Mapping storage provides an extremely simple storage
  88. implementation that doesn't provide undo or version support.
  89.  
  90. It is meant to illustrate the simplest possible storage.
  91.  
  92. The Mapping storage uses a single data structure to map
  93. object ids to data.
  94.  
  95. The Demo storage serves two purposes:
  96.  
  97.   - Provide an example implementation of a full storage without
  98.     distracting storage details,
  99.  
  100.   - Provide a volatile storage that is useful for giving demonstrations.
  101.  
  102. The demo strorage can have a "base" storage that is used in a
  103. read-only fashion. The base storage must not not to contain version
  104. data.
  105.  
  106. There are three main data structures:
  107.  
  108.   _data -- Transaction logging information necessary for undo
  109.  
  110.       This is a mapping from transaction id to transaction, where
  111.       a transaction is simply a 4-tuple:
  112.  
  113.         packed, user, description, extension_data, records
  114.  
  115.       where extension_data is a dictionary or None and records are the
  116.       actual records in chronological order. Packed is a flag
  117.       indicating whethe the transaction has been packed or not
  118.  
  119.   _index -- A mapping from oid to record
  120.  
  121.   _vindex -- A mapping from version name to version data
  122.  
  123.       where version data is a mapping from oid to record
  124.  
  125. A record is a tuple:
  126.  
  127.   oid, serial, pre, vdata, p, 
  128.  
  129. where:
  130.  
  131.      oid -- object id
  132.  
  133.      serial -- object serial number
  134.  
  135.      pre -- The previous record for this object (or None)
  136.  
  137.      vdata -- version data
  138.  
  139.         None if not a version, ortherwise:
  140.            version, non-version-record
  141.  
  142.      p -- the pickle data or None
  143.  
  144. The pickle data will be None for a record for an object created in
  145. an aborted version.
  146.  
  147. It is instructive to watch what happens to the internal data structures
  148. as changes are made.  Foe example, in Zope, you can create an external
  149. method::
  150.  
  151.   import Zope
  152.  
  153.   def info(RESPONSE):
  154.       RESPONSE['Content-type']= 'text/plain'
  155.  
  156.       return Zope.DB._storage._splat()
  157.  
  158. and call it to minotor the storage.
  159.  
  160. """
  161. __version__='$Revision: 1.3 $'[11:-2]
  162.  
  163. import POSException, BaseStorage, string, utils
  164. from TimeStamp import TimeStamp
  165.  
  166. class MappingStorage(BaseStorage.BaseStorage):
  167.  
  168.     def __init__(self, name='Mapping Storage'):
  169.  
  170.         BaseStorage.BaseStorage.__init__(self, name)
  171.  
  172.         self._index={}
  173.         self._tindex=[]
  174.  
  175.         # Note:
  176.         # If you subclass this and use a persistent mapping facility
  177.         # (e.g. a dbm file), you will need to get the maximum key and
  178.         # save it as self._oid.  See dbmStorage.
  179.  
  180.     def __len__(self):
  181.         return len(self._index)
  182.         
  183.     def getSize(self):
  184.         s=32
  185.         index=self._index
  186.         for oid in index.keys():
  187.             p=index[oid]
  188.             s=s+56+len(p)
  189.             
  190.         return s
  191.  
  192.     def load(self, oid, version):
  193.         self._lock_acquire()
  194.         try:
  195.             p=self._index[oid]
  196.             return p[8:], p[:8] # pickle, serial
  197.         finally: self._lock_release()
  198.  
  199.     def store(self, oid, serial, data, version, transaction):
  200.         if transaction is not self._transaction:
  201.             raise POSException.StorageTransactionError(self, transaction)
  202.  
  203.         if version:
  204.             raise POSException.Unsupported, "Versions aren't supported"
  205.  
  206.         self._lock_acquire()
  207.         try:
  208.             if self._index.has_key(oid):
  209.                 old=self._index[oid]
  210.                 oserial=old[:8]
  211.                 if serial != oserial: raise POSException.ConflictError
  212.                 
  213.             serial=self._serial
  214.             self._tindex.append((oid,serial+data))
  215.         finally: self._lock_release()
  216.  
  217.         return serial
  218.  
  219.     def _clear_temp(self):
  220.         self._tindex=[]
  221.  
  222.     def _finish(self, tid, user, desc, ext):
  223.  
  224.         index=self._index
  225.         for oid, p in self._tindex: index[oid]=p
  226.  
  227.     def pack(self, t, referencesf):
  228.         
  229.         self._lock_acquire()
  230.         try:    
  231.             # Build an index of *only* those objects reachable
  232.             # from the root.
  233.             index=self._index
  234.             rootl=['\0\0\0\0\0\0\0\0']
  235.             pop=rootl.pop
  236.             pindex={}
  237.             referenced=pindex.has_key
  238.             while rootl:
  239.                 oid=pop()
  240.                 if referenced(oid): continue
  241.     
  242.                 # Scan non-version pickle for references
  243.                 r=index[oid]
  244.                 pindex[oid]=r
  245.                 p=r[8:]
  246.                 referencesf(p, rootl)
  247.  
  248.             # Now delete any unreferenced entries:
  249.             for oid in index.keys():
  250.                 if not referenced(oid): del index[oid]
  251.     
  252.         finally: self._lock_release()
  253.  
  254.     def _splat(self):
  255.         """Spit out a string showing state.
  256.         """
  257.         o=[]
  258.         o.append('Index:')
  259.         index=self._index
  260.         keys=index.keys()
  261.         keys.sort()
  262.         for oid in keys:
  263.             r=index[oid]
  264.             o.append('  %s: %s, %s' %
  265.                      (utils.u64(oid),TimeStamp(r[:8]),`r[8:]`))
  266.             
  267.         return string.join(o,'\n')
  268.